dropboxUploadSessionFinish

Type

command

Summary

Finish an upload session and save the uploaded data to the given file path.

Syntax

dropboxUploadSessionFinish <pAccessToken>, <pSession>, <pOffset>, <pPath>, <pMode>, <pAutorename>, <pMute>, <pData>, [<pCallback>]

Description

note

A single request should not upload more than 150 MB of file contents.

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

• The request ID which will be the value of the it variable after calling the command
• The HTTP response code
• The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters

Name	Type	Description
pAccessToken		An OAuth2 Access token to access the user's account
pSession		A session ID as returned by dropboxUploadSessionStart.
pOffset		The amount of data that has been uploaded so far. We use this to make sure upload data isn't lost or duplicated in the event of a network error.
pPath		Path in the user's Dropbox to upload to.
pMode		Selects what to do if the file already exists. The default for this union is add. "add": Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, "document.txt" might become "document (2).txt". "overwrite": Always overwrite the existing file. The autorename strategy is the same as it is for add. "update": Overwrite if the given "rev" matches the existing file's "rev". The autorename strategy is to append the string "conflicted copy" to the file name. For example, "document.txt" might become "document (conflicted copy).txt" or "document (Panda's conflicted copy).txt".
pAutoRename		If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False.
pMute		Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False
pData		The binary file data
pCallback		The handler to call when the request is complete. If empty the command will block until complete.